home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1999 #2 / Amiga Plus CD - 1999 - No. 2.iso / System-Boost / Workbench / stopmenu / all / docs / english / StopMenu.doc < prev   
Encoding:
Text File  |  1998-11-09  |  7.9 KB  |  275 lines
  1. ====================Documentation for StopMenu======================
  2. =============================SHAREWARE==============================
  3.  
  4.     TABLE OF CONTENTS
  5.  
  6.     1. Program information
  7.     2. Author
  8.     3. Distribution
  9.     4. How to register?
  10.     5. Using StopMenu
  11.     6. Using Prefs
  12.     7. How to create menus file?
  13.     8. Others
  14.  
  15. ====================================================================
  16.  
  17. ======================
  18. 1. Program information
  19. ======================
  20.  
  21. StopMenu is invisible after start.  If you want to see him you must
  22. place your mouse pointer on the bottom of your screen.  You will see
  23. window with buttons and clock.  Using this buttons you can:
  24. -easy start yours programs
  25. -control commodities
  26. -easy start programs from SYS:Prefs/ drawer
  27. -control screens and save they as IFF files
  28. -control windows on workbench
  29.  
  30. =========
  31. 2. Author
  32. =========
  33.  
  34. I'm 16 years old and I weekly speak english.  I'm developing programs
  35. for 2 years (using C language).  This is my first SHAREWARE program.
  36. It's also my best program (IMHO).  My e-mail address:
  37.  
  38.                         tmsn@polbox.com
  39.  
  40. ===============
  41. 3. Distribution
  42. ===============
  43.  
  44. StopMenu is SHAREWARE, so you can use unregistred version 3 weeks.
  45. After this time you MUST register (see chapter 4) or delete it.
  46. If you register, you will get a special KeyFile.  You must put it
  47. in StopMenu: directory.  It will disable shareware requests.  You
  48. can't copy and distribute it (IT ISN'T LEGAL), but you can freely
  49. distribute unregistred version.
  50.  
  51. ===================
  52. 4. How to register?
  53. ===================
  54.  
  55. If you want to register you have to run "register" program (it's
  56. in StopMenu:Extras/) or press "Register now" button in Prefs.
  57. After language selection you have to input ALL needed informations
  58. about you (full name, e-mail, street/house, city/zip, country) and
  59. select way to transfer KeyFile (e-mail or normal (snail) mail).
  60. Now print (or view and manually rewrite) order form and put it
  61. into envelope. Don't forget include cash !!! (5 USD (or 8 USD if
  62. you want get KeyFile via snail-mail)).  If you want get Key via
  63. snail-mail include a blank 3.5" floppy disk.  Now, send order to:
  64.  
  65.     Tomasz Wójcik
  66.     ul. Grabowa 2
  67.     27-200 Starachowice
  68.     POLAND
  69.  
  70. When I get your order, I will send you KeyFile.
  71. Thank you for supporting SHAREWARE.
  72.  
  73. =================
  74. 5. Using StopMenu
  75. =================
  76.  
  77. When you move your mouse pointer to bottom of screen you will see
  78. a nice bar containing 5 buttons.  Using this buttons you can open
  79. some menus.
  80.  
  81. -Menu 1: Stop
  82. This menu containing your favorite programs.  You can edit content
  83. of this menu editing file StopMenu:StopMenu.menus using any text
  84. editor (for example: Ed, Ced, GoldEd, ...). See chapter 7.
  85.  
  86. -Menu 2: Commodities
  87. Using this menu you can kill, activate, deactivate, show and hide
  88. any commodity in your system.
  89.  
  90. -Menu 3: Preferences
  91. It is to easy and fast run programs from SYS:Prefs/
  92.  
  93. -Menu 4: Screens
  94. Using this menu you can move to front or back, remove or save as IFF
  95. any opened screen.  WARNING: Removing screens can be dangerous !
  96.  
  97. -Menu 5: WBWindows
  98. Using this menu you can move to front or back, remove, close or
  99. activate any window on workbench. WARNING: Removing windows can be
  100. dangerous !
  101.  
  102. ==============
  103. 6. Using Prefs
  104. ==============
  105.  
  106. If you run Prefs program, you will see the window.  On left side of
  107. this window you can select the group of options, which will be
  108. displayed in right side of window.
  109.  
  110. -Group 1: Info
  111. Here is displayed information about StopMenu.  You can also run
  112. registration program from this group.
  113.  
  114. -Group 2: Colors
  115. Here you can define some colors:
  116.  
  117.     -MenuBack (background color for menus)
  118.     -BarBack (background color for bar)
  119.     -Selected (color for selected item in menu)
  120.     -Shine (color of shine text)
  121.     -Shadow (color of shadow text)
  122.  
  123. To change this colors you must input hexadecimal values of colors
  124. ( in this format: RRGGBB, where RR is hex value of red (form 0 (00)
  125. to 255 (ff)), GG - green, BB - blue ). Some examples:
  126.  
  127. White - ffffff
  128. Red - ff0000
  129. Dark green - 006b00
  130. Grey - 939393
  131. Black - 000000
  132. Azure - 00ffff
  133. Yellow - ffff00
  134. Violet - dd00dd
  135.  
  136. Best (IMHO) values:
  137.     -MenuBack   afafaf
  138.     -BarBack    9f9f9f
  139.     -Selected   1626b6
  140.     -Shine      ffffff
  141.     -Shadow     000000
  142.  
  143. In this group you can also change the type of text in menu.
  144.  
  145. -Group 3: On/Off
  146. Here you can switch On/Off some program functions.
  147.  
  148. -Group 4: Hotkeys
  149. Here you can set some hotkeys:
  150.  
  151.     -Exit from program
  152.     -Run Prefs
  153.     -Restart program
  154.  
  155. and a priority for process (best values are 0 and 1).
  156.  
  157. -Groups 5,6,7,8: SkipLists
  158. (Commodities, Preferences, Screens, WBWindows)
  159. Here you can define names of objests to be skipped.
  160.  
  161. ============================
  162. 7. How to create menus file?
  163. ============================
  164.  
  165. Configuration of menu stop must be defined in file StopMenu.menus
  166. between <BEGIN> and <END> lines.  Example:
  167.  
  168. <BEGIN>
  169. MENU 1
  170.     ITEM Submenu 1,,1,MENU,2
  171.     ITEM Submenu 2,,1,MENU,3
  172.     ITEM Submenu 3,,1,MENU,4
  173.     BAR
  174.     ITEM Prefs,RUNPREFS,18,COMMAND
  175.     ITEM Quit,QUIT,6,COMMAND
  176. MENU 2
  177.     ITEM Submenu 4,,1,MENU,5
  178.     ITEM Some item,path:program,2,CLI
  179.     ITEM Other item,disk:directory/program,2,WB
  180. MENU 3
  181.     ITEM Program 1,disk:directory/program,2,WB
  182.     ITEM Program 2,disk:directory/program,2,WB
  183.     ITEM Program 3,disk:directory/program,2,WB
  184.     ITEM Program 4,disk:directory/program,2,WB
  185.     ITEM Program 5,disk:directory/program,2,WB
  186.     ITEM Program 6,disk:directory/program,2,WB
  187. MENU 4
  188.     ITEM CLI Proram,path:program,2,CLI
  189.     ITEM WB Proram,path:program,2,WB
  190.     ITEM AmigaDOS Script,path:script,2,SCRIPT
  191.     SPACE
  192.     ITEM Restart,RESTART,6,COMMAND
  193. MENU 5
  194.     ITEM Next submenu,,1,MENU,6
  195. MENU 6
  196.     ITEM Blah blah blah,,2,CLI
  197.     ITEM Blah blah blah,,2,CLI
  198.     ITEM Blah blah blah,,2,CLI
  199. <END>
  200.  
  201. As you see, it isn't very difficult.  After <BEGIN> line you must
  202. write MENU line (in this line you can also write somethin else,
  203. for example number of menu, but only for your information, it is
  204. completly ignored by program).  MENU line is used for mark begin
  205. of menu description.  Then you can place some items.  There are
  206. 3 types of items:
  207. -ITEM (normal item used to run programs or open submenus)
  208. -BAR (a nice horizontal bar)
  209. -SPACE (space between items)
  210. After item you have to write:
  211.  
  212.     Name,File,Icon number,Type of item,Submenu to open
  213.  
  214. where name is a text which will be displayed in menu, file is a
  215. file name to run (or execute) (WARNING: if type of item is COMMAND
  216. file must be one of following: QUIT (quit program), RUNPREFS (run
  217. Prefs program), RESTART (restart StopMenu), REBOOT (reboots amiga)).
  218. Icon number is a number of icon which will be displayed in menu,
  219. Type of item is one of following:
  220. -CLI (run cli program)
  221. -WB (run workbench program)
  222. -SCRIPT (execute AmigaDOS script)
  223. -MENU (open submenu)
  224. -COMMAN (execute internal command)
  225. Submenu to open is ONLY if type of item is MENU.  Is's used to
  226. specify number of menu, which will be linked to this item.
  227.  
  228. =========
  229. 8. Others
  230. =========
  231.  
  232.     How to create custom icons?
  233.     ---------------------------
  234.  
  235. You can add your custom icons (to directory StopMenu:Icons/), but
  236. you have to remember: icons must be named successive (for example:
  237. 47.info, 48.info, 49.info, ...).  To create new icons run InjectBrush
  238. (StopMenu:Extras/).  For example:
  239. 1. Draw 1 or 2 brushes (dimensions max. 18x22 pixels) and save as
  240.     ram:1.bsh ram:2.bsh
  241. 2. Copy StopMenu:icons/program/std.info to ram:
  242. 3. InjectBrush ram:std.info ram:1.bsh FORCE
  243.     (or if 2 brushes):
  244.     InjectBrush ram:std.info ram:1.bsh ram:2.bsh FORCE
  245. 4. Copy ram:std.info to StopMenu:icons/51.info
  246.  
  247. If you create 2 brushes, second will be displayed when item is
  248. selected.
  249.  
  250.     How to get updates?
  251.     -------------------
  252.  
  253. At the moment, only from AMINET. Maybe in future registred users
  254. may get the newest versions via e-mail.
  255.  
  256.     My suggestions:
  257.     ---------------
  258.  
  259. 1. Run program on 64 or more colors screen.
  260. 2. Keep StopMenuStarter.info in SYS:WBStartup/
  261.  
  262.     Future (version 2)
  263.     ------------------
  264.  
  265. -Editor for menu "Stop"
  266. -Plug-ins
  267. -Font change
  268. -and many others...
  269.  
  270. ====================================================================
  271.  
  272.                                                 Tom "Th0m$0n" Wójcik
  273.  
  274. ====================================================================
  275.